/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright( c ) 2009-2010  Realtek Corporation.*/

#ifndef __RTL8821AE__FW__H__
#define __RTL8821AE__FW__H__
#include "def.h"

#define FW_8821AE_SIZE					0x8000
#define FW_8821AE_START_ADDRESS			0x1000
#define FW_8821AE_END_ADDRESS			0x5FFF
#define FW_8821AE_PAGE_SIZE				4096
#define FW_8821AE_POLLING_DELAY			5
#define FW_8821AE_POLLING_TIMEOUT_COUNT	6000

#define IS_FW_HEADER_EXIST_8812( _pfwhdr )	\
	( ( le16_to_cpu( _pfwhdr->signature ) & 0xFFF0 ) == 0x9500 )

#define IS_FW_HEADER_EXIST_8821( _pfwhdr )	\
	( ( le16_to_cpu( _pfwhdr->signature ) & 0xFFF0 ) == 0x2100 )

#define USE_OLD_WOWLAN_DEBUG_FW 0

#define H2C_8821AE_RSVDPAGE_LOC_LEN		5
#define H2C_8821AE_PWEMODE_LENGTH			7
#define H2C_8821AE_JOINBSSRPT_LENGTH		1
#define H2C_8821AE_AP_OFFLOAD_LENGTH		3
#define H2C_8821AE_WOWLAN_LENGTH			3
#define H2C_8821AE_KEEP_ALIVE_CTRL_LENGTH	3
#if ( USE_OLD_WOWLAN_DEBUG_FW == 0 )
#define H2C_8821AE_REMOTE_WAKE_CTRL_LEN	1
#else
#define H2C_8821AE_REMOTE_WAKE_CTRL_LEN	3
#endif
#define H2C_8821AE_AOAC_GLOBAL_INFO_LEN	2
#define H2C_8821AE_AOAC_RSVDPAGE_LOC_LEN	7
#define H2C_8821AE_DISCONNECT_DECISION_CTRL_LEN	3

/* Fw PS state for RPWM.
*BIT[2:0] = HW state

*BIT[3] = Protocol PS state,
1: register active state ,
0: register sleep state

*BIT[4] = sub-state
*/
#define	FW_PS_GO_ON			BIT( 0 )
#define	FW_PS_TX_NULL			BIT( 1 )
#define	FW_PS_RF_ON			BIT( 2 )
#define	FW_PS_REGISTER_ACTIVE	BIT( 3 )

#define	FW_PS_DPS		BIT( 0 )
#define	FW_PS_LCLK		( FW_PS_DPS )
#define	FW_PS_RF_OFF		BIT( 1 )
#define	FW_PS_ALL_ON		BIT( 2 )
#define	FW_PS_ST_ACTIVE		BIT( 3 )
#define	FW_PS_ISR_ENABLE	BIT( 4 )
#define	FW_PS_IMR_ENABLE	BIT( 5 )

#define	FW_PS_ACK		BIT( 6 )
#define	FW_PS_TOGGLE		BIT( 7 )

 /* 8821AE RPWM value*/
 /* BIT[0] = 1: 32k, 0: 40M*/
 /* 32k*/
#define	FW_PS_CLOCK_OFF		BIT( 0 )
/*40M*/
#define	FW_PS_CLOCK_ON		0

#define	FW_PS_STATE_MASK		( 0x0F )
#define	FW_PS_STATE_HW_MASK	( 0x07 )
/*ISR_ENABLE, IMR_ENABLE, and PS mode should be inherited.*/
#define	FW_PS_STATE_INT_MASK	( 0x3F )

#define	FW_PS_STATE( x )			( FW_PS_STATE_MASK & ( x ) )
#define	FW_PS_STATE_HW( x )		( FW_PS_STATE_HW_MASK & ( x ) )
#define	FW_PS_STATE_INT( x )	( FW_PS_STATE_INT_MASK & ( x ) )
#define	FW_PS_ISR_VAL( x )		( ( x ) & 0x70 )
#define	FW_PS_IMR_MASK( x )	( ( x ) & 0xDF )
#define	FW_PS_KEEP_IMR( x )		( ( x ) & 0x20 )

#define	FW_PS_STATE_S0		( FW_PS_DPS )
#define	FW_PS_STATE_S1		( FW_PS_LCLK )
#define	FW_PS_STATE_S2		( FW_PS_RF_OFF )
#define	FW_PS_STATE_S3		( FW_PS_ALL_ON )
#define	FW_PS_STATE_S4		( ( FW_PS_ST_ACTIVE ) | ( FW_PS_ALL_ON ) )
 /* ( ( FW_PS_RF_ON ) | ( FW_PS_REGISTER_ACTIVE ) )*/
#define	FW_PS_STATE_ALL_ON_8821AE	( FW_PS_CLOCK_ON )
 /* ( FW_PS_RF_ON )*/
#define	FW_PS_STATE_RF_ON_8821AE	( FW_PS_CLOCK_ON )
 /* 0x0*/
#define	FW_PS_STATE_RF_OFF_8821AE	( FW_PS_CLOCK_ON )
 /* ( FW_PS_STATE_RF_OFF )*/
#define	FW_PS_STATE_RF_OFF_LOW_PWR_8821AE	( FW_PS_CLOCK_OFF )

#define	FW_PS_STATE_ALL_ON_92C	( FW_PS_STATE_S4 )
#define	FW_PS_STATE_RF_ON_92C		( FW_PS_STATE_S3 )
#define	FW_PS_STATE_RF_OFF_92C	( FW_PS_STATE_S2 )
#define	FW_PS_STATE_RF_OFF_LOW_PWR_92C	( FW_PS_STATE_S1 )

/* For 8821AE H2C PwrMode Cmd ID 5.*/
#define	FW_PWR_STATE_ACTIVE	( ( FW_PS_RF_ON ) | ( FW_PS_REGISTER_ACTIVE ) )
#define	FW_PWR_STATE_RF_OFF	0

#define	FW_PS_IS_ACK( x )		( ( x ) & FW_PS_ACK )
#define	FW_PS_IS_CLK_ON( x )	( ( x ) & ( FW_PS_RF_OFF | FW_PS_ALL_ON ) )
#define	FW_PS_IS_RF_ON( x )	( ( x ) & ( FW_PS_ALL_ON ) )
#define	FW_PS_IS_ACTIVE( x )	( ( x ) & ( FW_PS_ST_ACTIVE ) )
#define	FW_PS_IS_CPWM_INT( x )	( ( x ) & 0x40 )

#define	FW_CLR_PS_STATE( x )	( ( x ) = ( ( x ) & ( 0xF0 ) ) )

#define	IS_IN_LOW_POWER_STATE_8821AE( __state )		\
			( FW_PS_STATE( __state ) == FW_PS_CLOCK_OFF )

#define	FW_PWR_STATE_ACTIVE	( ( FW_PS_RF_ON ) | ( FW_PS_REGISTER_ACTIVE ) )
#define	FW_PWR_STATE_RF_OFF	0

enum rtl8821a_h2c_cmd {
	H2C_8821AE_RSVDPAGE = 0,
	H2C_8821AE_MSRRPT = 1,
	H2C_8821AE_SCAN = 2,
	H2C_8821AE_KEEP_ALIVE_CTRL = 3,
	H2C_8821AE_DISCONNECT_DECISION = 4,
	H2C_8821AE_INIT_OFFLOAD = 6,
	H2C_8821AE_AP_OFFLOAD = 8,
	H2C_8821AE_BCN_RSVDPAGE = 9,
	H2C_8821AE_PROBERSP_RSVDPAGE = 10,

	H2C_8821AE_SETPWRMODE = 0x20,
	H2C_8821AE_PS_TUNING_PARA = 0x21,
	H2C_8821AE_PS_TUNING_PARA2 = 0x22,
	H2C_8821AE_PS_LPS_PARA = 0x23,
	H2C_8821AE_P2P_PS_OFFLOAD = 024,

	H2C_8821AE_WO_WLAN = 0x80,
	H2C_8821AE_REMOTE_WAKE_CTRL = 0x81,
	H2C_8821AE_AOAC_GLOBAL_INFO = 0x82,
	H2C_8821AE_AOAC_RSVDPAGE = 0x83,

	H2C_RSSI_21AE_REPORT = 0x42,
	H2C_8821AE_RA_MASK = 0x40,
	H2C_8821AE_SELECTIVE_SUSPEND_ROF_CMD,
	H2C_8821AE_P2P_PS_MODE,
	H2C_8821AE_PSD_RESULT,
	/*Not defined CTW CMD for P2P yet*/
	H2C_8821AE_P2P_PS_CTW_CMD,
	MAX_8821AE_H2CCMD
};

#define pagenum_128( _len )	( u32 )( ( ( _len )>>7 ) + ( ( _len )&0x7F ? 1 : 0 ) )

#define SET_8812_H2CCMD_WOWLAN_FUNC_ENABLE( __cmd, __value )		\
	u8p_replace_bits( __cmd, __value, BIT( 0 ) )
#define SET_8812_H2CCMD_WOWLAN_PATTERN_MATCH_ENABLE( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 1 ) )
#define SET_8812_H2CCMD_WOWLAN_MAGIC_PKT_ENABLE( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 2 ) )
#define SET_8812_H2CCMD_WOWLAN_UNICAST_PKT_ENABLE( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 3 ) )
#define SET_8812_H2CCMD_WOWLAN_ALL_PKT_DROP( __cmd, __value )		\
	u8p_replace_bits( __cmd, __value, BIT( 4 ) )
#define SET_8812_H2CCMD_WOWLAN_GPIO_ACTIVE( __cmd, __value )		\
	u8p_replace_bits( __cmd, __value, BIT( 5 ) )
#define SET_8812_H2CCMD_WOWLAN_REKEY_WAKE_UP( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 6 ) )
#define SET_8812_H2CCMD_WOWLAN_DISCONNECT_WAKE_UP( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 7 ) )
#define SET_8812_H2CCMD_WOWLAN_GPIONUM( __cmd, __value )		\
	*( u8 * )( __cmd + 1 ) = __value
#define SET_8812_H2CCMD_WOWLAN_GPIO_DURATION( __cmd, __value )	\
	*( u8 * )( __cmd + 2 ) = __value

#define SET_H2CCMD_PWRMODE_PARM_MODE( __ph2ccmd, __val )			\
	*( u8 * )__ph2ccmd = __val
#define SET_H2CCMD_PWRMODE_PARM_RLBM( __cmd, __value )		\
	u8p_replace_bits( __cmd + 1, __value, GENMASK( 3, 0 ) )
#define SET_H2CCMD_PWRMODE_PARM_SMART_PS( __cmd, __value )	\
	u8p_replace_bits( __cmd + 1, __value, GENMASK( 7, 4 ) )
#define SET_H2CCMD_PWRMODE_PARM_AWAKE_INTERVAL( __cmd, __value )	\
	*( u8 * )( __cmd + 2 ) = __value
#define SET_H2CCMD_PWRMODE_PARM_ALL_QUEUE_UAPSD( __cmd, __value )		\
	*( u8 * )( __cmd + 3 ) = __value
#define SET_H2CCMD_PWRMODE_PARM_PWR_STATE( __cmd, __value )	\
	*( u8 * )( __cmd + 4 ) = __value
#define SET_H2CCMD_PWRMODE_PARM_BYTE5( __cmd, __value )		\
	*( u8 * )( __cmd + 5 ) = __value

#define SET_H2CCMD_RSVDPAGE_LOC_PSPOLL( __ph2ccmd, __val )		\
	*( u8 * )( __ph2ccmd + 1 ) = __val
#define SET_H2CCMD_RSVDPAGE_LOC_NULL_DATA( __ph2ccmd, __val )		\
	*( u8 * )( __ph2ccmd + 2 ) = __val
#define SET_H2CCMD_RSVDPAGE_LOC_QOS_NULL_DATA( __ph2ccmd, __val )		\
	*( u8 * )( __ph2ccmd + 3 ) = __val
#define SET_H2CCMD_RSVDPAGE_LOC_BT_QOS_NULL_DATA( __ph2ccmd, __val )	\
	*( u8 * )( __ph2ccmd + 4 ) = __val

/* _MEDIA_STATUS_RPT_PARM_CMD1 */
#define SET_H2CCMD_MSRRPT_PARM_OPMODE( __cmd, __value )	\
	u8p_replace_bits( __cmd + 1, __value, BIT( 0 ) )
#define SET_H2CCMD_MSRRPT_PARM_MACID_IND( __cmd, __value )	\
	u8p_replace_bits( __cmd + 1, __value, BIT( 1 ) )

/* AP_OFFLOAD */
#define SET_H2CCMD_AP_OFFLOAD_ON( __cmd, __value )	\
	*( u8 * )__cmd = __value
#define SET_H2CCMD_AP_OFFLOAD_HIDDEN( __cmd, __value )	\
	*( u8 * )( __cmd + 1 ) = __value
#define SET_H2CCMD_AP_OFFLOAD_DENYANY( __cmd, __value )	\
	*( u8 * )( __cmd + 2 ) = __value
#define SET_H2CCMD_AP_OFFLOAD_WAKEUP_EVT_RPT( __cmd, __value ) \
	*( u8 * )( __cmd + 3 ) = __value

/* Keep Alive Control*/
#define SET_8812_H2CCMD_KEEP_ALIVE_ENABLE( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 0 ) )
#define SET_8812_H2CCMD_KEEP_ALIVE_ACCPEPT_USER_DEFINED( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 1 ) )
#define SET_8812_H2CCMD_KEEP_ALIVE_PERIOD( __cmd, __value )	\
	*( u8 * )( __cmd + 1 ) = __value

/*REMOTE_WAKE_CTRL */
#define SET_8812_H2CCMD_REMOTE_WAKECTRL_ENABLE( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 0 ) )
#define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_ARP_OFFLOAD_EN( __cmd, __value )\
	u8p_replace_bits( __cmd, __value, BIT( 1 ) )
#define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_NDP_OFFLOAD_EN( __cmd, __value )\
	u8p_replace_bits( __cmd, __value, BIT( 2 ) )
#define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_GTK_OFFLOAD_EN( __cmd, __value )\
	u8p_replace_bits( __cmd, __value, BIT( 3 ) )
#define SET_8812_H2CCMD_REMOTE_WAKE_CTRL_REALWOWV2_EN( __cmd, __value )\
	u8p_replace_bits( __cmd, __value, BIT( 6 ) )

/* GTK_OFFLOAD */
#define SET_8812_H2CCMD_AOAC_GLOBAL_INFO_PAIRWISE_ENC_ALG( __cmd, __value )\
	*( u8 * )__cmd = __value
#define SET_8812_H2CCMD_AOAC_GLOBAL_INFO_GROUP_ENC_ALG( __cmd, __value )	\
	*( u8 * )( __cmd + 1 ) = __value

/* AOAC_RSVDPAGE_LOC */
#define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_REMOTE_WAKE_CTRL_INFO( __cmd, __value )	\
	*( u8 * )__cmd = __value
#define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_ARP_RSP( __cmd, __value )	\
	*( u8 * )( __cmd + 1 ) = __value
#define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_NEIGHBOR_ADV( __cmd, __value )\
	*( u8 * )( __cmd + 2 ) = __value
#define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_RSP( __cmd, __value )	\
	*( u8 * )( __cmd + 3 ) = __value
#define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_INFO( __cmd, __value )	\
	*( u8 * )( __cmd + 4 ) = __value
#define SET_8821AE_H2CCMD_AOAC_RSVDPAGE_LOC_GTK_EXT_MEM( __cmd, __value )	\
	*( u8 * )( __cmd + 5 ) = __value

/* Disconnect_Decision_Control */
#define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_ENABLE( __cmd, __value )	\
	u8p_replace_bits( __cmd, __value, BIT( 0 ) )
#define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_USER_SETTING( __cmd, __value )\
	u8p_replace_bits( __cmd, __value, BIT( 1 ) )
#define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_CHECK_PERIOD( __cmd, __value )\
	*( u8 * )( __cmd + 1 ) = __value
#define SET_8812_H2CCMD_DISCONNECT_DECISION_CTRL_TRYPKT_NUM( __cmd, __value )\
	*( u8 * )( __cmd + 2 ) = __value

int rtl8821ae_download_fw( struct ieee80211_hw *hw, bool buse_wake_on_wlan_fw );
#if ( USE_SPECIFIC_FW_TO_SUPPORT_WOWLAN == 1 )
void rtl8821ae_set_fw_related_for_wowlan( struct ieee80211_hw *hw,
					 bool used_wowlan_fw );

#endif
void rtl8821ae_fill_h2c_cmd( struct ieee80211_hw *hw, u8 element_id,
			    u32 cmd_len, u8 *cmdbuffer );
void rtl8821ae_firmware_selfreset( struct ieee80211_hw *hw );
void rtl8821ae_set_fw_pwrmode_cmd( struct ieee80211_hw *hw, u8 mode );
void rtl8821ae_set_fw_media_status_rpt_cmd( struct ieee80211_hw *hw,
					   u8 mstatus );
void rtl8821ae_set_fw_ap_off_load_cmd( struct ieee80211_hw *hw,
				      u8 ap_offload_enable );
void rtl8821ae_set_fw_rsvdpagepkt( struct ieee80211_hw *hw,
				  bool b_dl_finished, bool dl_whole_packet );
void rtl8812ae_set_fw_rsvdpagepkt( struct ieee80211_hw *hw,
				  bool b_dl_finished, bool dl_whole_packet );
void rtl8821ae_set_p2p_ps_offload_cmd( struct ieee80211_hw *hw,
				      u8 p2p_ps_state );
void rtl8821ae_set_fw_wowlan_mode( struct ieee80211_hw *hw, bool func_en );
void rtl8821ae_set_fw_remote_wake_ctrl_cmd( struct ieee80211_hw *hw,
					   u8 enable );
void rtl8821ae_set_fw_keep_alive_cmd( struct ieee80211_hw *hw, bool func_en );
void rtl8821ae_set_fw_disconnect_decision_ctrl_cmd( struct ieee80211_hw *hw,
						   bool enabled );
void rtl8821ae_set_fw_global_info_cmd( struct ieee80211_hw *hw );
void rtl8821ae_c2h_ra_report_handler( struct ieee80211_hw *hw,
				     u8 *cmd_buf, u8 cmd_len );
#endif
